<html>
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
    <title>param3d_properties</title>
  </head>
  <body bgcolor="#FFFFFF">
    <center>Scilab Data type</center>
    <div align="right">Last update : 10/10/2005</div>
    <p>
      <b>param3d_properties</b> - description of the 3D curves
  entities properties</p>
    <h3>
      <font color="blue">Description</font>
    </h3>
    <p>The Param3d entity is a leaf of the graphics entities hierarchy.</p>
    <dl>
      <dd>
        <b>visible: </b>This field contains the <tt>
          <b>visible</b>
        </tt> property value for
        the entity . It should be <tt>
          <b>"on" </b>
        </tt> or <tt>
          <b>"off"</b>
        </tt> .
        By default, the curves are visibles, the value's property is
        <tt>
          <b>"on" </b>
        </tt>. If <tt>
          <b>"off"</b>
        </tt> the curves are not drawn on
        the screen.</dd>
      <dd>
        <b>data: </b>This field contains the coordinates of the 3d curves. it is the
        matrix <tt>
          <b>[X,Y,Z]</b>
        </tt> such as <tt>
          <b>X(:,i)</b>
        </tt>,
        <tt>
          <b>Y(:,i)</b>
        </tt>, <tt>
          <b>Z(:,i)</b>
        </tt> contain the 3D coordinates of
        the <tt>
          <b>i</b>
        </tt>'th curve. This field contains the default
        <tt>
          <b>line_style</b>
        </tt> property value for Segs, Arcs, Rectangle and
        Polyline objects.</dd>
      <dd>
        <b>line_mode: </b>This field contains the default <tt>
          <b>line_mode</b>
        </tt> property
        value for the polyline. Its value should be <tt>
          <b>"on" </b>
        </tt>(line
        drawn) or <tt>
          <b>"off"</b>
        </tt> (no line drawn).</dd>
      <dd>
        <b>line_style: </b>This field selects the type of line to be used to draw lines . Its
        value should be an integer in [0 6]. 0 stands for solid, the other
        values stand for a selection of dashes (see
        <a href="getlinestyle.htm">
          <tt>
            <b>getlinestyle</b>
          </tt>
        </a>).</dd>
      <dd>
        <b>polyline_style: </b>This field selects the way curve are drawn: interpolated
        (default), staircase, barplot, arrowed and filled modes are available
        through integer index [1:5].</dd>
      <dd>
        <b>mark_mode: </b>This field contains the default <tt>
          <b>mark_mode</b>
        </tt> property
        value. Its value should be <tt>
          <b>"on"</b>
        </tt> or <tt>
          <b>"off"</b>
        </tt>
        (default value).</dd>
      <dd>
        <b>mark_style: </b>This field contains the default <tt>
          <b>mark_style</b>
        </tt> property
        value. The <tt>
          <b>mark_style</b>
        </tt> selects the type of mark to be
        displayed. Its value should be an integer in [0 9] which stands for:
        dot, plus, cross, star, filled diamond, diamond, triangle up, triangle
        down, trefle and circle.</dd>
      <dd>
        <b>mark_size_unit: </b>This field contains the default <tt>
          <b>mark_size_unit</b>
        </tt>
        property value. If <tt>
          <b>mark_size_unit</b>
        </tt> is set to
        <tt>
          <b>"point"</b>
        </tt>, then the <tt>
          <b>mark_size</b>
        </tt> value is
        directly given in points. When <tt>
          <b>mark_size_unit</b>
        </tt> is set to
        <tt>
          <b>"tabulated"</b>
        </tt>, <tt>
          <b>mark_size</b>
        </tt> is computed relative
        to the font size array: therefore, its value should be an integer in
        [0 5] whith stands for 8pt, 10pt, 12pt, 14pt, 18pt and 24pt. Note that
        <a href="param3d.htm">
          <tt>
            <b>param3d</b>
          </tt>
        </a> and pure scilab functions use
        <tt>
          <b>tabulated</b>
        </tt> mode as default ; when using <a href="plot.htm">
          <tt>
            <b>plot</b>
          </tt>
        </a>
        function, the <tt>
          <b>point</b>
        </tt> mode is automatically enabled.</dd>
      <dd>
        <b>mark_size: </b>This field contains the default <tt>
          <b>mark_size</b>
        </tt> property
        value. The <tt>
          <b>mark_size</b>
        </tt> selects the font size of the mark to
        be displayed. Its value should be an integer in [0 5] whith stands for
        8pt, 10pt, 12pt, 14pt, 18pt and 24pt (see <a href="getmark.htm">
          <tt>
            <b>getmark</b>
          </tt>
        </a>).</dd>
      <dd>
        <b>mark_foreground: </b>This field contains the <tt>
          <b>mark_foreground</b>
        </tt> property
        value which is the marks' edge color. Its value should be a color
        index (relative to the current color_map).</dd>
      <dd>
        <b>mark_background: </b>This field contains the <tt>
          <b>mark_background</b>
        </tt> property
        value which is the marks' face color. Its value should be a color
        index (relative to the current color_map).</dd>
      <dd>
        <b>thickness: </b>This field contains the default <tt>
          <b>thickness</b>
        </tt> value of
        the lines used to draw the axes and the curves. It should be a
        positive integer.</dd>
      <dd>
        <b>foreground: </b>This field contains the color index used to draw the curves. Its
        value should be a color index (relative to the current colormap).</dd>
      <dd>
        <b>clip_state: </b>This field contains the default <tt>
          <b>clip_state</b>
        </tt> property
        value. Its value should be :<dl>
          <dd>
            <b></b>
            <tt>
              <b>"off"</b>
            </tt> this means that all curves created after
            that are not clipped (default value).</dd>
          <dd>
            <b></b>
            <tt>
              <b>"clipgrf"</b>
            </tt> this means that all curves created
            after that are clipped outside the Axes boundaries.</dd>
          <dd>
            <b></b>
            <tt>
              <b>"on"</b>
            </tt> this means that all curves created after
            that are clipped outside the rectangle given by property
            clip_box.</dd>
        </dl>
      </dd>
      <dd>
        <b>clip_box: </b>This field contains the default <tt>
          <b>clip_box</b>
        </tt> property
        value. Its value should be an empty matrix if clip_state is
        <tt>
          <b>"off"</b>
        </tt>. Other case the clipping is given by the vector
        <tt>
          <b>[x,y,w,h]</b>
        </tt> (upper-left point width height).</dd>
      <dd>
        <b>user_data: </b>This field can be use to store any scilab variable in the
	  param3d data structure, and to retreive it.</dd>
      <dd>
        <b>parent: </b>This property contains the handle of the parent. The parent of the
        3D curves entity should be of type <tt>
          <b>"Axes"</b>
        </tt> or
        <tt>
          <b>"Compound"</b>
        </tt>.</dd>
    </dl>
    <h3>
      <font color="blue">Examples</font>
    </h3>
    <pre>
   

   set("figure_style","new") //create a figure
   a=get("current_axes");//get the handle of the newly created axes
   t=[0:0.1:5*%pi]';
   param3d1([sin(t),sin(2*t)],[cos(t),cos(2*t)],[t/10,sin(t)])
  
   a.rotation_angles=[65,75]; 
   a.data_bounds=[-1,-1,-1;1,1,2]; //boundaries given by data_bounds
   a.thickness = 2;
   h=a.children //get the handle of the param3d entity: an Compound composed of 2 curves
   h.children(1).foreground = 3 // first curve
   curve2 = h.children(2);
   curve2.foreground = 6;
   curve2.mark_style = 2;

 
  </pre>
    <h3>
      <font color="blue">See Also</font>
    </h3>
    <p>
      <a href="set.htm">
        <tt>
          <b>set</b>
        </tt>
      </a>,&nbsp;&nbsp;<a href="get.htm">
        <tt>
          <b>get</b>
        </tt>
      </a>,&nbsp;&nbsp;<a href="delete.htm">
        <tt>
          <b>delete</b>
        </tt>
      </a>,&nbsp;&nbsp;<a href="param3d.htm">
        <tt>
          <b>param3d</b>
        </tt>
      </a>,&nbsp;&nbsp;<a href="param3d1.htm">
        <tt>
          <b>param3d1</b>
        </tt>
      </a>,&nbsp;&nbsp;<a href="graphics_entities.htm">
        <tt>
          <b>graphics_entities</b>
        </tt>
      </a>,&nbsp;&nbsp;</p>
    <h3>
      <font color="blue">Author</font>
    </h3>
    <p>Djalel ABDEMOUCHE</p>
  </body>
</html>
